Skip to content

minor fixes#34

Merged
bomanaps merged 2 commits intoPatrick-Ehimen:mainfrom
bomanaps:fix/turbo
Oct 27, 2025
Merged

minor fixes#34
bomanaps merged 2 commits intoPatrick-Ehimen:mainfrom
bomanaps:fix/turbo

Conversation

@bomanaps
Copy link
Copy Markdown
Collaborator

@bomanaps bomanaps commented Oct 27, 2025 •
edited by sourcery-ai Bot
Loading

Pull Request

Description

Type of change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Other (describe):

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Related Issues

Screenshots (if applicable)

Summary by Sourcery

Standardize project documentation, enhance TypeScript package scripts, and update license.

Enhancements:

  • Standardize README title capitalization and remove duplicate header section

Build:

  • Add build, dev, clean, and type-check scripts to the types package

Chores:

  • Update root package license from ISC to MIT

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented Oct 27, 2025 •
edited
Loading

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR applies minor fixes across documentation, package scripts, and project metadata by refining the README, adding build-related scripts to the types package, and updating the license.

Class diagram for updated package scripts in types package

classDiagram
class package_json {
  +build: "tsc"
  +dev: "tsc --watch"
  +clean: "rm -rf dist"
  +type-check: "tsc --noEmit"
  +lint: "eslint ."
  +lint:fix: "eslint . --fix"
  +format: "prettier --write ."
}
Loading

File-Level Changes

Change Details Files
Refined project title and removed duplicate introduction in documentation
  • Capitalized project name header
  • Removed redundant description block
 README.md
Augmented types package with build and development scripts
  • Added build script (tsc)
  • Added dev script (tsc --watch)
  • Added clean script (rm -rf dist)
  • Added type-check script (tsc --noEmit)
 packages/types/package.json
Updated project license to MIT
  • Changed license field from ISC to MIT
 package.json
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai Bot reviewed Oct 27, 2025
View reviewed changes
Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey there - I've reviewed your changes and they look great!

Prompt for AI Agents 
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location> `packages/types/package.json:10` </location>
<code_context>
   "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "clean": "rm -rf dist",
+    "type-check": "tsc --noEmit",
     "lint": "eslint .",
</code_context>

<issue_to_address>
**suggestion:** Consider cross-platform compatibility for the clean script.

`rm -rf` won't work on Windows. Consider using `rimraf` for cross-platform support.

Suggested implementation:

```
    "clean": "rimraf dist",

```

If `rimraf` is not already installed, run `npm install --save-dev rimraf` in your project directory to add it as a devDependency.
</issue_to_address>
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread packages/types/package.json Outdated
@bomanaps bomanaps merged commit f54c086 into Patrick-Ehimen:main Oct 27, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@bomanaps